SureTax DRC API
Patch Form Instances
Overview
This API endpoint facilitates the updating of the status associated with a form instance. It allows clients to modify the status of a form instance based on their specific requirements or workflow processes.
OperationId: Patch Form Instances
Authorization Method(s): OAuth
Verb: PATCH
End Point: /api/Forms/FormInstances
Example Request
The following is an json request for this operation.
{
"formInstances": [
{
"id": "string",
"status": "string"
}
]
}Overview
Response object for PATCH requests that update form instances, including error messages for any issues encountered during the update process.
Example Response
The following is an example response you can expect for this operation
{
"data": {
"formInstances": [
{
"id": "FORM12345",
"errorMessage": "No errors."
},
{
"id": "FORM67890",
"errorMessage": "Error while updating form instance."
}
]
}
}
Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.
| code | description |
|---|---|
| 200 | The API response contains the updated form instances along with any error messages. |
| 400 | Bad request. Invalid data provided. |
| 401 | Unauthorized access. |
| 500 | Internal server error. |